docs(cli): document macOS dmg installer and script options in install README#408
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
install/README.mdhad drifted from the actual contents ofinstall/. Notably, the signed macOS.dmgGUI installer (CodeMie Connect_2.0.1_aarch64_signed.dmg) was completely undocumented, the PowerShell and shell bootstrap scripts' parameters/env-vars were only partially covered, and the example release tag was stale. This PR brings the README in sync with the folder.Changes
.dmginstaller, plus intro/distribution-list entries (previously only the Windows wizard was documented).install.ps1parameter table (-Mode,-Version,-RegistryUrl,-ScopeRegistryUrl,-InstallRoot,-DryRun) — previously only-Version/-InstallRootwere mentioned.install.shenv-var table (CODEMIE_INSTALL_MODE,CODEMIE_NPM_PREFIX,CODEMIE_PACKAGE_VERSION,CODEMIE_REGISTRY_URL,CODEMIE_SCOPE_REGISTRY_URL) — previously onlyCODEMIE_PACKAGE_VERSIONwas documented.v0.0.57→v0.8.0(matchespackage.json).portablefor Windows;auto/npm-global/user-prefixfor macOS/Linux) so the two platforms' defaults read as symmetric rather than inconsistent.CODEMIE_INSTALL_URLpoints at the directory containinginstall.ps1, not the file.Testing
install/README.md, +59/−8).npm run lintclean (zero warnings).npm run typecheckclean.install.ps1,install.sh,install.cmd).v0.0.57tag fully removed (0 occurrences).Checklist
docs(cli): …)main(branch created fromda7d0df)